Cobrar / Receber com QR Code Estático

O QR Code Estático contém informações fixas que não mudam com o tempo, mantendo os mesmos dados desde sua criação.

Casos de Uso

1. Pagamentos em estabelecimentos físicos: empresas podem gerar QR codes estáticos usando o Pix e exibi-los em seus estabelecimentos. Permitindo que os clientes escaneiem o QR Code diretamente no aplicativo de pagamento escolhido. Isso acelera o processo de pagamento e elimina a necessidade de usar PoS'.
2. Doações: instituições de caridade e organizações sem fins lucrativos podem usar o QR Code Estático do Pix para receber doações de forma rápida e conveniente. Pessoas interessadas em contribuir podem escanear o código e fazer pagamentos diretamente de seus dispositivos móveis.

Requisição

URL

POST 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/static'

cURL

curl --location 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/static' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: ${apiKey}' \
--data '{
    "type": "PIX_STATIC",
    "correlationId": "2f908499-685c-4e36-af04-30567dc08dc5",
    "description": "pix estático com valor",
    "amount": 9.99,
    "additionalInformation": "Testando qrcode"
}'

Headers

Name	Description
x-delbank-api-key	Required. API key
idempotencyKey	Required GUID

Corpo

Nome	Type	Description
correlationId	string	Obrigatório. Id de correlação para conciliação com o sistema cliente Este valor será retornado nas integração via webhook e pode ser utilizado para consultar a cobrança e pagamentos
description	string	Descrição interna da cobrança
amount	number	Valor da cobrança. Caso não informado, será considerado que o cliente pagadorpoderá informar qual valor deseja pagar
pixKey	string	Caso deseje usar uma chave específica
additionalInformation	string	Informações que serão mostradas ao cliente pagador Tamanho máximo: 64 caracteres
formatResponse	enum	Informe PAYLOAD_AND_QRCODE, se quiser o payload e a imagem do QR code, se não for passado irá gerar somente com payload

Exemplo

A maneira mais fácil de gerar um QR Code estático é a seguinte:

// exemplo I
{
  "correlationId": "{{$guid}}",
  "description": "static pix without value"
}

Além das informações escritas acima, é possível enviar um TEXTO que será apresentado ao cliente pagador. Outra informação importante que é possível fornecer é o valor, e se isso não for fornecido, indica que o cliente pagador pode informar o valor que deseja pagar (usado frequentemente em cenários de doação).

// exemplo II
{
    "correlationId": "{{$guid}}",
    "description": "static pix with amount",
    "amount": 9.99,
    "additionalInformation": "Testing QR Code"
}

É possível gerar o QR code com uma imagem e/ou inserir uma chave Pix específica:

// examplo III
{
    "pixKey": "5b0ac9a4-fad6-43f9-be70-6d7c9a2fad26",
    "correlationId": "{{$guid}}",
    "description": "pix estático sem valor",
    "amount": 9.99,
    "additionalInfo": "Testando qrcode",
    "formatResponse": "PAYLOAD_AND_QRCODE"
}

Resposta

O código de status 200 implicará que a transação foi bem-sucedida

Sendo bem-sucedida, o retorno terá os seguintes campos como Json:

Name	Type	Description
transactionId	string	O QR code Id
correlationId	string	Correlation Id.
amount	number	Valor da cobrança (se houver)
pixKey	string	A chave Pix usada
beneficiaryName	string	Nome do recebedor
address	object	Objeto contendo a informação de endereço
additionalInfo	string	Informações que serão mostradas ao cliente pagador
createdAt	DATETIME	Data e hora que o QR code foi criado
payloadPix	string	O payload usado para pagar o QR code (Pix copia e cola)
base64Image	string	Imagem base64 do qrcode

{
    "transactionId": "vchargeffeeed94cdbc41",
    "correlationId": "6f388279-0658-4bfa-80e5-e5c405cdb318",
    "amount": 9.99,
    "pixKey": "5b0ac9a4-fad6-43f9-be70-6d7c9a2fad26",
    "beneficiaryName": "DELBANK",
    "address": {
        "cityName": "ARACAJU",
        "zipCode": "49000000",
        "uf": "SE",
        "state": "SE",
        "street": "LOGRADOURO"
    },
    "additionalInfo": "testing qrcode",
    "createdAt": "2024-12-10T11:51:55.306Z",
    "payloadPix": "00026540014br.gov.bcb.pix0114+55119999757340214testing qrcode52040000530398654049.995802BR5907DELBANK6007ARACAJU62250521vchargeffeeed94cdbc41630494CD",
    "base64Image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPoAAA=="
}